package com.example.customconsume.config;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import lombok.extern.slf4j.Slf4j;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description springdoc 配置
 * @Author lihw
 * @Date 2024/7/4 11:17
 */
@Slf4j
@Configuration
public class SpringDocConfig {

    /**
     * Springdoc OpenAPI 提供了多种自定义配置选项，例如 API 文档的元数据、API 分组、路径过滤等
     *
     * @return
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                // 文档的元数据
                .info(new Info()
                        .title("Custom API")
                        .version("1.0")
                        .description("This is a custom API description"))
                // 指定了一个名为 bearerAuth 的安全方案，这个名称必须与 components 中定义的 SecurityScheme 名称匹配
                .addSecurityItem(new SecurityRequirement().addList("bearerAuth"))
                .components(new Components()
                        .addSecuritySchemes("bearerAuth",
                                new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")));
    }

    /**
     * 接口分组配置1
     * @return
     */
    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("test-api")
                .pathsToMatch("/test/**")
                .packagesToScan("com.example.customconsume.controller.test")
                .build();
    }

    /**
     * 接口分组配置2
     * @return
     */
    @Bean
    public GroupedOpenApi adminApi() {
        return GroupedOpenApi.builder()
                .group("admin-api")
                .pathsToMatch("/admin/**")
                .packagesToScan("com.example.customconsume.controller.admin")
                .build();
    }

}
